home *** CD-ROM | disk | FTP | other *** search
/ Internet Tools (InfoMagic) / Internet Tools.iso / dos_win / winsnmp / agent / dpi_mib.txt next >
Text File  |  1994-11-01  |  16KB  |  422 lines
  1. -- the SUBAGENT MIB
  2.  
  3. -- The MIB objects are implemented by the local SNMP agent
  4.  
  5. -- This MIB is based on some experience with both DPI and SMUX
  6. -- subagents. As you can see, some of the ideas come from the
  7. -- original SMUX MIB (RFC1227) by Marshall Rose.
  8. -- We try to define a subagent MIB that represents subagents
  9. -- using different protocols.
  10.  
  11.         SUBAGENT-MIB DEFINITIONS ::= BEGIN
  12.  
  13.         IMPORTS
  14.                 enterprises, TimeTicks, Counter
  15.                         FROM RFC1155-SMI
  16.                 OBJECT-TYPE
  17.                         FROM RFC-1212
  18.                 DisplayString
  19.                         FROM RFC1213-MIB;
  20.  
  21.         ibm     OBJECT IDENTIFIER ::= { enterprises 2 }
  22.  
  23.         ibmResearch OBJECT IDENTIFIER ::= { ibm 4 }
  24.  
  25.         saMIB   OBJECT IDENTIFIER ::= { ibmResearch 12 }
  26.         --
  27.         -- Following can be used once we fit into SNMPv2
  28.         --
  29.         --      MODULE-IDENTITY, OBJECT-TYPE, snmpModules
  30.         --              FROM SNMPv2-SMI
  31.         --
  32.         -- saMIB MODULE-IDENTITY
  33.         --  LAST-UPDATED "9403200000Z"
  34.         --  ORGANIZATION "IBM Research - T.J. Watson Research Center"
  35.         --  CONTACT-INFO
  36.         --          "           Bert Wijnen
  37.         --
  38.         --           Postal:    IBM International Operations
  39.         --                      Watsonweg 2
  40.         --                      1423 ND Uithoorn
  41.         --                      The Netherlands
  42.         --
  43.         --           Tel:       +31 2975 53316
  44.         --           Fax:       +31 2975 62468
  45.         --
  46.         --           E-mail:    wijnen@vnet.ibm.com
  47.         --                      (IBM internal: wijnen at nlvm1)"
  48.         --   DESCRIPTION
  49.         --          "The MIB module describing SNMP subagents."
  50.         --   ::= { snmpModules x }
  51.  
  52.         saDefaultTimeout OBJECT-TYPE
  53.                 SYNTAX  INTEGER    -- (1..saMaxTimeout)
  54.         --      UNITS   "seconds"
  55.                 ACCESS  read-write
  56.                 STATUS  mandatory
  57.                 DESCRIPTION
  58.                     "The default timeout (in seconds) that this agent
  59.                     waits for a response from a SubAgent. This value
  60.                     is used if a timeout value is not specified for
  61.                     the subtree nor for the subagent that exports
  62.                     the subtree."
  63.         --      DEFVAL  { 5 }
  64.                 ::= { saMIB 1 }
  65.  
  66.         saMaxTimeout OBJECT-TYPE
  67.                 SYNTAX  INTEGER (1..3600) -- 3600 is 60 minutes,
  68.                                           -- so quite big already
  69.         --      UNITS   "seconds"
  70.                 ACCESS  read-write
  71.                 STATUS  mandatory
  72.                 DESCRIPTION
  73.                     "The maximum timeout (in seconds) that this agent
  74.                     allows for timeout values for SubAgents. When you
  75.                     try to set any other timeout value it must be
  76.                     between 1 and this maximum value."
  77.         --      DEFVAL  { 60 }
  78.                 ::= { saMIB 2 }
  79.  
  80.         saAllowDuplicateIDs     OBJECT-TYPE
  81.                 SYNTAX  INTEGER {
  82.                             yes(1),
  83.                             no(2)
  84.                         }
  85.                 ACCESS  read-write
  86.                 STATUS  mandatory
  87.                 DESCRIPTION
  88.                     "Controls if multiple instances of a sub-agent (as
  89.                      identified by the sub-agent Identifier) are allowed.
  90.  
  91.                      Setting this object to the value no(2) will prevent
  92.                      (new) duplicate sub-agentIDs. However, if any
  93.                      duplicates exist at that point in time, the agent
  94.                      will not remove them. That is considered a manager
  95.                      responsibility."
  96.         --      DEFVAL  { yes }
  97.                 ::= { saMIB 3 }
  98.  
  99.         saNumber        OBJECT-TYPE
  100.                 SYNTAX  Counter
  101.                 ACCESS  read-only
  102.                 STATUS  mandatory
  103.                 DESCRIPTION
  104.                     "The number of entries in the saTable"
  105.                 ::= { saMIB 4 }
  106.  
  107.         saAllPacketsIn  OBJECT-TYPE
  108.                 SYNTAX  Counter
  109.                 ACCESS  read-only
  110.                 STATUS  mandatory
  111.                 DESCRIPTION
  112.                     "A count of packets received from all subagents."
  113.                 ::= { saMIB 5 }
  114.  
  115.         saAllPacketsOut OBJECT-TYPE
  116.                 SYNTAX  Counter
  117.                 ACCESS  read-only
  118.                 STATUS  mandatory
  119.                 DESCRIPTION
  120.                     "A count of packets send to all subagents."
  121.                 ::= { saMIB 6 }
  122.  
  123.         saTable OBJECT-TYPE
  124.                 SYNTAX  SEQUENCE OF SaEntry
  125.                 ACCESS  not-accessible
  126.                 STATUS  mandatory
  127.                 DESCRIPTION
  128.                     "The SubAgent table, listing all subagents."
  129.                 ::= { saMIB 7 }
  130.  
  131.         saEntry OBJECT-TYPE
  132.                 SYNTAX  SaEntry
  133.                 ACCESS  not-accessible
  134.                 STATUS  mandatory
  135.                 DESCRIPTION
  136.                     "An entry in the SubAgent table."
  137.                 INDEX   { saIndex }
  138.                 ::= { saTable 1 }
  139.  
  140.         SaEntry ::=
  141.            SEQUENCE {
  142.                saIndex
  143.                    INTEGER,
  144.                saIdentifier
  145.                    OBJECT IDENTIFIER,
  146.                saDescription
  147.                    DisplayString,
  148.                saStatus
  149.                    INTEGER,
  150.                saStatusChangeTime
  151.                    TimeTicks,
  152.                saProtocol
  153.                    INTEGER,
  154.                saProtocolVersion
  155.                    INTEGER,
  156.                saProtocolRelease
  157.                    INTEGER,
  158.                saTransport
  159.                    INTEGER,
  160.                saTransportAddress
  161.                    OCTET STRING,
  162.                saTimeout
  163.                    INTEGER,
  164.                saMaxVarBinds
  165.                    INTEGER,
  166.                saPacketsIn
  167.                    Counter,
  168.                saPacketsOut
  169.                    Counter
  170.            }
  171.  
  172.         saIndex OBJECT-TYPE
  173.                 SYNTAX  INTEGER (1..4294967295)
  174.                 ACCESS  read-only
  175.                 STATUS  mandatory
  176.                 DESCRIPTION
  177.                     "An index which uniquely identifies a SubAgent.
  178.                     The number is in the range from 1 up to and
  179.                     including the value of saNumber."
  180.                 ::= { saEntry 1 }
  181.  
  182.         saIdentifier    OBJECT-TYPE
  183.                 SYNTAX  OBJECT IDENTIFIER
  184.                 ACCESS  read-only
  185.                 STATUS  mandatory
  186.                 DESCRIPTION
  187.                     "The authoritative identification for a SubAgent."
  188.                 ::= { saEntry 2 }
  189.  
  190.         saDescription   OBJECT-TYPE
  191.                 SYNTAX  DisplayString (SIZE (0..255))
  192.                 ACCESS  read-only
  193.                 STATUS  mandatory
  194.                 DESCRIPTION
  195.                     "A descriptive name for a SubAgent."
  196.                 ::= { saEntry 3 }
  197.  
  198.         saStatus        OBJECT-TYPE
  199.                 SYNTAX  INTEGER {
  200.                             valid(1),
  201.                             invalid(2),
  202.                             connecting(3),
  203.                             disconnecting(4),
  204.                             closedByManager(5),
  205.                             closedByAgent(6),
  206.                             closedBySubAgent(7),
  207.                             closedBySubAgentTimeout(8),
  208.                             closedBySubAgentError(9)
  209.                         }
  210.                 ACCESS  read-write
  211.                 STATUS  mandatory
  212.                 DESCRIPTION
  213.                     "The status of the SubAgent.
  214.  
  215.                      The only value that can be set is invalid(2).
  216.                      This can only be done if the status is not already
  217.                      in a ClosedSomething status.
  218.  
  219.                      Setting this object to the value invalid(2) has
  220.                      the effect of invalidating the entry upon which
  221.                      the agent will close the connection and turn it
  222.                      to status closedByManager(7).
  223.  
  224.                      It is an implementation specific matter if an
  225.                      entry that is not valid(1) is removed from the
  226.                      table. However, if such an entry is kept and the
  227.                      subagent re-connects, then the same entry must
  228.                      be re-used."
  229.                 ::= { saEntry 4 }
  230.  
  231.         saStatusChangeTime OBJECT-TYPE
  232.                 SYNTAX  TimeTicks
  233.                 ACCESS  read-only
  234.                 STATUS  mandatory
  235.                 DESCRIPTION
  236.                     "The timestamp of the last status change of the
  237.                      SubAgent. Timestamp is taken from the sysUpTime."
  238.                 ::= { saEntry 5 }
  239.  
  240.         saProtocol      OBJECT-TYPE
  241.                 SYNTAX  INTEGER {
  242.                             dpi(1),   -- SNMP DPI, RFC 1228 & 1592
  243.                             moh(2),   -- SNMP MIB Object Handler
  244.                             smux(3)   -- SNMP MUX, RFC 1227
  245.                         }
  246.                 ACCESS  read-only
  247.                 STATUS  mandatory
  248.                 DESCRIPTION
  249.                     "The SubAgent protocol being used."
  250.                 ::= { saEntry 6 }
  251.  
  252.         saProtocolVersion       OBJECT-TYPE
  253.                 SYNTAX  INTEGER
  254.                 ACCESS  read-only
  255.                 STATUS  mandatory
  256.                 DESCRIPTION
  257.                     "The version of the SubAgent Protocol used."
  258.                 ::= { saEntry 7 }
  259.  
  260.         saProtocolRelease       OBJECT-TYPE
  261.                 SYNTAX  INTEGER
  262.                 ACCESS  read-only
  263.                 STATUS  mandatory
  264.                 DESCRIPTION
  265.                     "The release of the SubAgent Protocol used."
  266.                 ::= { saEntry 8 }
  267.  
  268.         saTransport     OBJECT-TYPE
  269.                 SYNTAX  INTEGER {
  270.                             udp(1),     -- User Datagram
  271.                             tcp(2),     -- Transmission Control
  272.                             nmq(3),     -- Named Queue
  273.                             sna(4)      -- IBM SNA
  274.                         }
  275.                 ACCESS  read-only
  276.                 STATUS  mandatory
  277.                 DESCRIPTION
  278.                     "The transport protocol used by the SubAgent."
  279.                 ::= { saEntry 9 }
  280.  
  281.         saTransportAddress      OBJECT-TYPE
  282.                 SYNTAX  OCTET STRING
  283.                 ACCESS  read-only
  284.                 STATUS  mandatory
  285.                 DESCRIPTION
  286.                     "The address of the subagent (transport specific
  287.                      address information)."
  288.                      -- IPaddress, Portnumber for UDP and TCP
  289.                      -- DisplayString for Named Queue
  290.                      -- DisplayString for SNA (LU-name)
  291.                 ::= { saEntry 10 }
  292.  
  293.         saTimeout       OBJECT-TYPE
  294.                 SYNTAX  INTEGER    -- (1..saMaxTimeout)
  295.         --      UNITS   "seconds"
  296.                 ACCESS  read-write
  297.                 STATUS  mandatory
  298.                 DESCRIPTION
  299.                     "The default timeout (seconds) for a SubAgent
  300.                      response. This value will be used if there is no
  301.                      timeout value specified for a particular subtree."
  302.         --      DEFVAL  { 0 }
  303.                 ::= { saEntry 11 }
  304.  
  305.         saMaxVarBinds   OBJECT-TYPE
  306.                 SYNTAX  INTEGER (0..4294967295)
  307.                 ACCESS  read-only
  308.                 STATUS  mandatory
  309.                 DESCRIPTION
  310.                     "Max varBinds this subagent accepts per request."
  311.                 ::= { saEntry 12 }
  312.  
  313.         saPacketsIn     OBJECT-TYPE
  314.                 SYNTAX  Counter
  315.                 ACCESS  read-only
  316.                 STATUS  mandatory
  317.                 DESCRIPTION
  318.                     "A count of packets received from this subagent."
  319.                 ::= { saEntry 13 }
  320.  
  321.         saPacketsOut    OBJECT-TYPE
  322.                 SYNTAX  Counter
  323.                 ACCESS  read-only
  324.                 STATUS  mandatory
  325.                 DESCRIPTION
  326.                     "A count of packets send to this subagent."
  327.                 ::= { saEntry 14 }
  328.  
  329.         saTreeTable     OBJECT-TYPE
  330.                 SYNTAX  SEQUENCE OF SaTreeEntry
  331.                 ACCESS  not-accessible
  332.                 STATUS  mandatory
  333.                 DESCRIPTION
  334.                     "The SubAgent tree table."
  335.                 ::= { saMIB 8 }
  336.  
  337.         saTreeEntry     OBJECT-TYPE
  338.                 SYNTAX  SaTreeEntry
  339.                 ACCESS  not-accessible
  340.                 STATUS  mandatory
  341.                 DESCRIPTION
  342.                     "An entry in the SubAgent tree table."
  343.                 INDEX   { saTsubtree, saTpriority }
  344.                 ::= { saTreeTable 1 }
  345.  
  346.         SaTreeEntry ::=
  347.             SEQUENCE {
  348.                 saTsubtree
  349.                     OBJECT IDENTIFIER,
  350.                 saTpriority
  351.                     INTEGER,
  352.                 saTindex
  353.                     INTEGER,
  354.                 saTstatus
  355.                     INTEGER,
  356.                 saTtimeout
  357.                     INTEGER
  358.             }
  359.  
  360.         saTsubtree      OBJECT-TYPE
  361.                 SYNTAX  OBJECT IDENTIFIER
  362.                 ACCESS  read-only
  363.                 STATUS  mandatory
  364.                 DESCRIPTION
  365.                     "The MIB subtree being exported by the SubAgent."
  366.                 ::= { saTreeEntry 1 }
  367.  
  368.         saTpriority     OBJECT-TYPE
  369.                 SYNTAX  INTEGER (0..'7fffffff'h)
  370.                 ACCESS  read-only
  371.                 STATUS  mandatory
  372.                 DESCRIPTION
  373.                     "The SubAgents Priority when exporting the MIB
  374.                      subtree. The lower the value the better the
  375.                      priority."
  376.                 ::= { saTreeEntry 2 }
  377.  
  378.         saTindex        OBJECT-TYPE
  379.                 SYNTAX  INTEGER
  380.                 ACCESS  read-only
  381.                 STATUS  mandatory
  382.                 DESCRIPTION
  383.                     "The SubAgent's identity (index into the saTable)."
  384.                 ::= { saTreeEntry 3 }
  385.  
  386.         saTstatus       OBJECT-TYPE
  387.                 SYNTAX  INTEGER {
  388.                             valid(1),   -- registered, active entry
  389.                             invalid(2), -- invalid, unregistered
  390.                             waiting(3)  -- registered, waiting cause
  391.                                         -- higher priority entry is
  392.                                         -- valid/active now
  393.                         }
  394.                 ACCESS  read-write
  395.                 STATUS  mandatory
  396.                 DESCRIPTION
  397.                     "The status of subtree exported by the SubAgent.
  398.  
  399.                      The only value that can be set is invalid(2).
  400.  
  401.                      Setting this object to the value invalid(2) has
  402.                      the effect of invalidating the entry.
  403.                      It is an implementation specific matter if an
  404.                      entry that is not valid(1) or waiting(3)
  405.                      is removed from the table."
  406.                 ::= { saTreeEntry 4 }
  407.  
  408.         saTtimeout      OBJECT-TYPE
  409.                 SYNTAX  INTEGER    -- (1..saMaxTimeout)
  410.         --      UNITS   "seconds"
  411.                 ACCESS  read-write
  412.                 STATUS  mandatory
  413.                 DESCRIPTION
  414.                     "The timeout (in seconds) for objects in this
  415.                      subtree. A value of zero (0) means that the
  416.                      overall timeout value (as specified in the
  417.                      saTableEntry for the SubAgent) will be used."
  418.         --      DEFVAL  { 0 }
  419.                 ::= { saTreeEntry 5 }
  420.  
  421.         END
  422.